<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pyopenspime.core.Error</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pyopenspime/">PyOpenSpime v0.1</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pyopenspime ::
        <a href="pyopenspime.core-module.html">Module&nbsp;core</a> ::
        Class&nbsp;Error
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyopenspime.core.Error-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Error</h1><p class="nomargin-top"><span class="codelink"><a href="pyopenspime.core-pysrc.html#Error">source&nbsp;code</a></span></p>
<pre class="base-tree">
xmpp.simplexml.Node --+        
                      |        
 xmpp.protocol.Protocol --+    
                          |    
           xmpp.protocol.Iq --+
                              |
                             <strong class="uidshort">Error</strong>
</pre>

<hr />
<p>PyOpenSpime Error stanza.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.core.Error-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">stanza</span>,
        <span class="summary-sig-arg">error_type</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">modify</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">error_cond</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">error_namespace</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">error_description</span>=<span class="summary-sig-default">None</span>)</span><br />
      Initialize an OpenSpime error stanza.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.core-pysrc.html#Error.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">tuple of unicode</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.core.Error-class.html#get_error" class="summary-sig-name">get_error</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves error condition and description from an error stanza.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.core-pysrc.html#Error.get_error">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>xmpp.protocol.Iq</code></b>:
      <code>buildReply</code>,
      <code>getQueryChildren</code>,
      <code>getQueryNS</code>,
      <code>getQueryPayload</code>,
      <code>getQuerynode</code>,
      <code>setQueryNS</code>,
      <code>setQueryPayload</code>,
      <code>setQuerynode</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>xmpp.protocol.Protocol</code></b>:
      <code>__setitem__</code>,
      <code>getError</code>,
      <code>getErrorCode</code>,
      <code>getFrom</code>,
      <code>getID</code>,
      <code>getProperties</code>,
      <code>getTimestamp</code>,
      <code>getTo</code>,
      <code>getType</code>,
      <code>setError</code>,
      <code>setFrom</code>,
      <code>setID</code>,
      <code>setTimestamp</code>,
      <code>setTo</code>,
      <code>setType</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>xmpp.simplexml.Node</code></b>:
      <code>__delitem__</code>,
      <code>__getattr__</code>,
      <code>__getitem__</code>,
      <code>__str__</code>,
      <code>addChild</code>,
      <code>addData</code>,
      <code>clearData</code>,
      <code>delAttr</code>,
      <code>delChild</code>,
      <code>getAttr</code>,
      <code>getAttrs</code>,
      <code>getCDATA</code>,
      <code>getChildren</code>,
      <code>getData</code>,
      <code>getName</code>,
      <code>getNamespace</code>,
      <code>getParent</code>,
      <code>getPayload</code>,
      <code>getTag</code>,
      <code>getTagAttr</code>,
      <code>getTagData</code>,
      <code>getTags</code>,
      <code>has_attr</code>,
      <code>setAttr</code>,
      <code>setData</code>,
      <code>setName</code>,
      <code>setNamespace</code>,
      <code>setParent</code>,
      <code>setPayload</code>,
      <code>setTag</code>,
      <code>setTagAttr</code>,
      <code>setTagData</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>xmpp.simplexml.Node</code></b>:
      <code>FORCE_NODE_RECREATION</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">stanza</span>,
        <span class="sig-arg">error_type</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">modify</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">error_cond</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">error_namespace</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">error_description</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.core-pysrc.html#Error.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialize an OpenSpime error stanza.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>stanza</code></strong> (pyopenspime.xmpp.simplexml.Node) - The original stanza that the error is build for.</li>
        <li><strong class="pname"><code>error_type</code></strong> (unicode) - The error type as defined by the XMPP protocol. Value MUST be 
          'cancel' -- do not retry (the error is unrecoverable), 'continue'
          -- proceed (the condition was only a warning), 'modify' -- retry 
          after changing the data sent, 'auth' -- retry after providing 
          credentials, 'wait' -- retry after waiting (the error is 
          temporary). Defaults to <i>modify</i>.</li>
        <li><strong class="pname"><code>error_cond</code></strong> (unicode) - The error condition.</li>
        <li><strong class="pname"><code>error_namespace</code></strong> (unicode) - The error condition namespace.</li>
        <li><strong class="pname"><code>error_description</code></strong> (unicode) - The error description.</li>
    </ul></dd>
    <dt>Overrides:
        xmpp.simplexml.Node.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="get_error"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_error</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.core-pysrc.html#Error.get_error">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves error condition and description from an error stanza. 
  Reference is OpenSpime protocol Core Reference Schema v0.9.</p>
  <dl class="fields">
    <dt>Returns: tuple of unicode</dt>
        <dd>(error_cond, error_description)</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pyopenspime/">PyOpenSpime v0.1</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Jun 09 18:55:16 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
